Screen.displaysData - Code Metrics - Inspection of "Also improve some JS logic" - jf-guillou/lcds - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 483e11...61b75c )

by Jeff

created 2016-11-03 09:38 UTC

Screen.displaysData A

↳ Parent: web/js/frontend.js

Complexity

Conditions	1
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
nc	2
nop	1

1 Function

Rating	Name	Duplication	Size	Complexity
A		0	3	1

/**
 * Screen class constructor
 * @param {string} updateScreenUrl global screen update checks url
 */
function Screen(updateScreenUrl) {
  this.fields = [];
  this.url = updateScreenUrl;
  this.lastChanges = null;
  this.endAt = null;
  this.nextUrl = null;
  this.stopping = false;
}

/**
 * Ajax GET on updateScreenUrl to check lastChanges timestamp and reload if necessary
 */
Screen.prototype.checkUpdates = function() {
  var s = this;
  $.get(this.url, function(j) {
    if (j.success) {
      if (s.lastChanges == null) {
        s.lastChanges = j.data.lastChanges;
      } else if (s.lastChanges != j.data.lastChanges) {
        s.reload();
        s.nextUrl = null;
        return;
      }

      if (j.data.duration > 0) {
        // Setup next screen
        s.reload(j.data.duration * 1000);
        s.nextUrl = j.data.nextScreenUrl;
      }
    }
  });
}

/**
 * Start Screen reload procedure, checking for every field timeout
 */
Screen.prototype.reload = function(minDuration) {
  var endAt = Date.now() + (minDuration ? minDuration : 0);
  if (this.stopping && this.endAt < endAt) {
    return;
  }

  this.endAt = minDuration ? Date.now() + minDuration : 0;
  this.stopping = true;
  for (var i in this.fields) {
    if (!this.fields.hasOwnProperty(i)) {
      continue;
    }
    var f = this.fields[i];
    if (f.timeout && f.endAt > this.endAt) {
      this.endAt = f.endAt;
    }
  }

  if (this.endAt === 0) {
    this.doReload();
  }
}

/**
 * Actual Screen reload action
 */
Screen.prototype.doReload = function() {
  if (this.nextUrl) {
    window.location = this.nextUrl;
  } else {
    window.location.reload();
  }
}

/**
 * Check every field for content
 * @param  {Content} data 
 * @return {boolean} content is displayed
 */
Screen.prototype.displaysData = function(data) {
  return this.fields.filter(function(field) {
    return field.current && field.current.data == data;
  }).length > 0;
}

/**
 * Content class constructor
 * @param {array} c content attributes
 */
function Content(c) {
  this.id = c.id;
  this.data = c.data;
  this.duration = c.duration * 1000;
  this.type = c.type;
  this.displayCount = 0;
}

/**
 * Field class constructor
 * @param {jQuery.Object} $f field object
 * @param {Screen} screen parent screen object
 */
function Field($f, screen) {
  this.$field = $f;
  this.id = $f.attr('data-id');
  this.url = $f.attr('data-url');
  this.types = $f.attr('data-types').split(' ');
  this.canUpdate = this.url != null;
  this.contents = [];
  this.previous = null;
  this.current = null;
  this.next = null;
  this.timeout = null;
  this.endAt = null;
  this.screen = screen;
}

/**
 * Retrieves contents from backend for this field
 */
Field.prototype.getContents = function() {
  if (!this.canUpdate) {
    return;
  }

  var f = this;
  $.get(this.url, function(j) {
    if (j.success) {
      f.contents = j.next.map(function(c) {
        return new Content(c);
      });
      if (!f.timeout && f.contents.length) {
        f.pickNext();
      }
    } else {
      f.setError(j.message || 'Error');
    }
  });
}

/**
 * Display error in field text
 */
Field.prototype.setError = function(err) {
  this.$field.text(err);
}

/**
 * Sort by displayCount and randomize order when equal displayCount
 */
Field.prototype.randomizeSortContents = function() {
  this.contents = this.contents.sort(function(a, b) {
    if (a.displayCount === b.displayCount) {
      return Math.random() - 0.5;
    }
    return a.displayCount - b.displayCount;
  });
}

/**
 * Loop through field contents to pick next displayable content
 */
Field.prototype.pickNext = function() {
  if (this.screen.stopping) { // Stoping screen
    if (this.screen.endAt < Date.now()) {
      this.screen.doReload();
      return;
    }
  }

  this.previous = this.current;
  this.current = null;
  var pData = this.previous && this.previous.data;
  // Avoid repeat & other field same content
  this.randomizeSortContents();
  for (var i = 0; i < this.contents.length; i++) {
    var c = this.contents[i];
    // Skip too long content
    if (this.screen.endAt != null && c.duration + Date.now() > this.screen.endAt) {
      continue;
    }

    if (c.data == pData) {
      // Will repeat, avoid if enough content
      if (this.contents.length < 2) {
        this.next = c;
        break;
      }
      continue;
    }

    if (this.screen.displaysData(c.data)) {
      // Same content already displayed on other field, avoid if enough content
      if (this.contents.length < 3) {
        this.next = c;
        break;
      }
      continue;
    }

    this.next = c;
  }

  this.display();
}

/**
 * Display next content in field html
 */
Field.prototype.display = function() {
  if (this.next && this.next.duration > 0) {
    this.current = this.next
    this.current.displayCount++;
    this.next = null;
    this.$field.html(this.current.data);
    this.$field.show();
    if (this.$field.text() != '') {
      this.$field.textfill({
        maxFontPixels: 0,
      });
    }
    if (this.timeout) {
      clearTimeout(this.timeout);
    }
    var f = this;
    this.timeout = setTimeout(function() {
      f.pickNext();
    }, this.current.duration);
    this.endAt = this.current.duration + Date.now()
  } else {
    this.timeout = null;
    console.error('No content to display for', this);
  }
}

/**
 * jQuery.load event
 * Initialize Screen and Fields
 * Setup updates interval timeouts
 */
function onLoad() {
  var screen = new Screen(updateScreenUrl);

  // Init
  $('.field').each(function() {
    var f = new Field($(this), screen);
    f.getContents();
    screen.fields.push(f);
  });

  // Setup content updates loop
  setInterval(function() {
    for (var f in screen.fields) {
var someObject;
for (var key in someObject) {
    if ( ! someObject.hasOwnProperty(key)) {
        continue; // Skip keys from the prototype.
    }

    doSomethingWith(key);
}
      screen.fields[f].getContents();
    }
    screen.checkUpdates();
  }, 60000);
  screen.checkUpdates();
}

// Run
$(onLoad);


1			/**
2			* Screen class constructor
3			* @param {string} updateScreenUrl global screen update checks url
4			*/
5			function Screen(updateScreenUrl) {
6			this.fields = [];
7			this.url = updateScreenUrl;
8			this.lastChanges = null;
9			this.endAt = null;
10			this.nextUrl = null;
11			this.stopping = false;
12			}
13
14			/**
15			* Ajax GET on updateScreenUrl to check lastChanges timestamp and reload if necessary
16			*/
17			Screen.prototype.checkUpdates = function() {
18			var s = this;
19			$.get(this.url, function(j) {
20			if (j.success) {
21			if (s.lastChanges == null) {
22			s.lastChanges = j.data.lastChanges;
23			} else if (s.lastChanges != j.data.lastChanges) {
24			s.reload();
25			s.nextUrl = null;
26			return;
27			}
28
29			if (j.data.duration > 0) {
30			// Setup next screen
31			s.reload(j.data.duration * 1000);
32			s.nextUrl = j.data.nextScreenUrl;
33			}
34			}
35			});
36			}
37
38			/**
39			* Start Screen reload procedure, checking for every field timeout
40			*/
41			Screen.prototype.reload = function(minDuration) {
42			var endAt = Date.now() + (minDuration ? minDuration : 0);
43			if (this.stopping && this.endAt < endAt) {
44			return;
45			}
46
47			this.endAt = minDuration ? Date.now() + minDuration : 0;
48			this.stopping = true;
49			for (var i in this.fields) {
50			if (!this.fields.hasOwnProperty(i)) {
51			continue;
52			}
53			var f = this.fields[i];
54			if (f.timeout && f.endAt > this.endAt) {
55			this.endAt = f.endAt;
56			}
57			}
58
59			if (this.endAt === 0) {
60			this.doReload();
61			}
62			}
63
64			/**
65			* Actual Screen reload action
66			*/
67			Screen.prototype.doReload = function() {
68			if (this.nextUrl) {
69			window.location = this.nextUrl;
70			} else {
71			window.location.reload();
72			}
73			}
74
75			/**
76			* Check every field for content
77			* @param {Content} data
78			* @return {boolean} content is displayed
79			*/
80			Screen.prototype.displaysData = function(data) {
81			return this.fields.filter(function(field) {
82			return field.current && field.current.data == data;
83			}).length > 0;
84			}
85
86			/**
87			* Content class constructor
88			* @param {array} c content attributes
89			*/
90			function Content(c) {
91			this.id = c.id;
92			this.data = c.data;
93			this.duration = c.duration * 1000;
94			this.type = c.type;
95			this.displayCount = 0;
96			}
97
98			/**
99			* Field class constructor
100			* @param {jQuery.Object} $f field object
101			* @param {Screen} screen parent screen object
102			*/
103			function Field($f, screen) {
104			this.$field = $f;
105			this.id = $f.attr('data-id');
106			this.url = $f.attr('data-url');
107			this.types = $f.attr('data-types').split(' ');
108			this.canUpdate = this.url != null;
109			this.contents = [];
110			this.previous = null;
111			this.current = null;
112			this.next = null;
113			this.timeout = null;
114			this.endAt = null;
115			this.screen = screen;
116			}
117
118			/**
119			* Retrieves contents from backend for this field
120			*/
121			Field.prototype.getContents = function() {
122			if (!this.canUpdate) {
123			return;
124			}
125
126			var f = this;
127			$.get(this.url, function(j) {
128			if (j.success) {
129			f.contents = j.next.map(function(c) {
130			return new Content(c);
131			});
132			if (!f.timeout && f.contents.length) {
133			f.pickNext();
134			}
135			} else {
136			f.setError(j.message \|\| 'Error');
137			}
138			});
139			}
140
141			/**
142			* Display error in field text
143			*/
144			Field.prototype.setError = function(err) {
145			this.$field.text(err);
146			}
147
148			/**
149			* Sort by displayCount and randomize order when equal displayCount
150			*/
151			Field.prototype.randomizeSortContents = function() {
152			this.contents = this.contents.sort(function(a, b) {
153			if (a.displayCount === b.displayCount) {
154			return Math.random() - 0.5;
155			}
156			return a.displayCount - b.displayCount;
157			});
158			}
159
160			/**
161			* Loop through field contents to pick next displayable content
162			*/
163			Field.prototype.pickNext = function() {
164			if (this.screen.stopping) { // Stoping screen
165			if (this.screen.endAt < Date.now()) {
166			this.screen.doReload();
167			return;
168			}
169			}
170
171			this.previous = this.current;
172			this.current = null;
173			var pData = this.previous && this.previous.data;
174			// Avoid repeat & other field same content
175			this.randomizeSortContents();
176			for (var i = 0; i < this.contents.length; i++) {
177			var c = this.contents[i];
178			// Skip too long content
179			if (this.screen.endAt != null && c.duration + Date.now() > this.screen.endAt) {
180			continue;
181			}
182
183			if (c.data == pData) {
184			// Will repeat, avoid if enough content
185			if (this.contents.length < 2) {
186			this.next = c;
187			break;
188			}
189			continue;
190			}
191
192			if (this.screen.displaysData(c.data)) {
193			// Same content already displayed on other field, avoid if enough content
194			if (this.contents.length < 3) {
195			this.next = c;
196			break;
197			}
198			continue;
199			}
200
201			this.next = c;
202			}
203
204			this.display();
205			}
206
207			/**
208			* Display next content in field html
209			*/
210			Field.prototype.display = function() {
211			if (this.next && this.next.duration > 0) {
212			this.current = this.next
213			this.current.displayCount++;
214			this.next = null;
215			this.$field.html(this.current.data);
216			this.$field.show();
217			if (this.$field.text() != '') {
218			this.$field.textfill({
219			maxFontPixels: 0,
220			});
221			}
222			if (this.timeout) {
223			clearTimeout(this.timeout);
224			}
225			var f = this;
226			this.timeout = setTimeout(function() {
227			f.pickNext();
228			}, this.current.duration);
229			this.endAt = this.current.duration + Date.now()
230			} else {
231			this.timeout = null;
232			console.error('No content to display for', this);
233			}
234			}
235
236			/**
237			* jQuery.load event
238			* Initialize Screen and Fields
239			* Setup updates interval timeouts
240			*/
241			function onLoad() {
242			var screen = new Screen(updateScreenUrl);
			0 ignored issues – show Bug introduced 2016-10-31 23:45 UTC by Report Bug Copy Issue Report The variable `updateScreenUrl` seems to be never declared. If this is a global, consider adding a `/** global: updateScreenUrl */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
243			// Init
244			$('.field').each(function() {
245			var f = new Field($(this), screen);
246			f.getContents();
247			screen.fields.push(f);
248			});
249
250			// Setup content updates loop
251			setInterval(function() {
252			for (var f in screen.fields) {
			0 ignored issues – show Complexity introduced 2016-10-31 23:45 UTC by Report Bug Copy Issue Report A for in loop automatically includes the property of any prototype object, consider checking the key using `hasOwnProperty`. When iterating over the keys of an object, this includes not only the keys of the object, but also keys contained in the prototype of that object. It is generally a best practice to check for these keys specifically: var someObject; for (var key in someObject) { if ( ! someObject.hasOwnProperty(key)) { continue; // Skip keys from the prototype. } doSomethingWith(key); } Loading history...
253			screen.fields[f].getContents();
254			}
255			screen.checkUpdates();
256			}, 60000);
257			screen.checkUpdates();
258			}
259
260			// Run
261			$(onLoad);
262

jf-guillou / lcds

Push — master ( 483e11...61b75c )

Screen.displaysData A

Complexity

Size

Duplication

Importance

1 Function

Duplication Side-by-Side

Filter issues like